File: //usr/lib/python2.7/site-packages/google/protobuf/message.pyo
�
Q�,Qc @ sh d Z d Z d e f d � � YZ d e f d � � YZ d e f d � � YZ d e f d � � YZ d
S( s6 Contains an abstract base class for protocol messages.s# robinson@google.com (Will Robinson)t Errorc B s e Z RS( ( t __name__t
__module__( ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyR ( s t DecodeErrorc B s e Z RS( ( R R ( ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyR ) s t EncodeErrorc B s e Z RS( ( R R ( ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyR * s t Messagec B s� e Z d Z g Z d Z d d � Z d � Z d � Z d � Z d � Z
d � Z d � Z d � Z
d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z RS( sU Abstract base class for protocol messages.
Protocol message classes are almost always generated by the protocol
compiler. These generated types subclass Message and implement the methods
shown below.
TODO(robinson): Link to an HTML document here.
TODO(robinson): Document that instances of this class will also
have an Extensions attribute with __getitem__ and __setitem__.
Again, not sure how to best convey this.
TODO(robinson): Document that the class must also have a static
RegisterExtension(extension_field) method.
Not sure how to best express at this point.
c C s t | � � } | j | � | S( N( t typet MergeFrom( t selft memot clone( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __deepcopy__F s
c C s
t � d S( s9 Recursively compares two messages by value and structure.N( t NotImplementedError( R t other_msg( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __eq__K s c C s | | k S( N( ( R R
( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __ne__O s c C s t d � � d S( Ns unhashable object( t TypeError( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __hash__S s c C s
t � d S( s7 Outputs a human-readable representation of the message.N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __str__V s c C s
t � d S( s7 Outputs a human-readable representation of the message.N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __unicode__Z s c C s
t � d S( s� Merges the contents of the specified message into current message.
This method merges the contents of the specified message into the current
message. Singular fields that are set in the specified message overwrite
the corresponding fields in the current message. Repeated fields are
appended. Singular sub-messages and groups are recursively merged.
Args:
other_msg: Message to merge into the current message.
N( R ( R R
( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyR ^ s c C s+ | | k r d S| j � | j | � d S( s� Copies the content of the specified message into the current message.
The method clears the current message and then merges the specified
message using MergeFrom.
Args:
other_msg: Message to copy into the current one.
N( t ClearR ( R R
( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt CopyFromk s
c C s
t � d S( s, Clears all data that was set in the message.N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyR y s c C s
t � d S( s Mark this as present in the parent.
This normally happens automatically when you assign a field of a
sub-message, but sometimes you want to make the sub-message
present while keeping it empty. If you find yourself using this,
you may want to reconsider your design.N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt SetInParent} s c C s
t � d S( s� Checks if the message is initialized.
Returns:
The method returns True if the message is initialized (i.e. all of its
required fields are set).
N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt
IsInitialized� s c C s
t � d S( sZ Merges serialized protocol buffer data into this message.
When we find a field in |serialized| that is already present
in this message:
- If it's a "repeated" field, we append to the end of our list.
- Else, if it's a scalar, we overwrite our field.
- Else, (it's a nonrepeated composite), we recursively merge
into the existing composite.
TODO(robinson): Document handling of unknown fields.
Args:
serialized: Any object that allows us to call buffer(serialized)
to access a string of bytes using the buffer interface.
TODO(robinson): When we switch to a helper, this will return None.
Returns:
The number of bytes read from |serialized|.
For non-group messages, this will always be len(serialized),
but for messages which are actually groups, this will
generally be less than len(serialized), since we must
stop when we reach an END_GROUP tag. Note that if
we *do* stop because of an END_GROUP tag, the number
of bytes returned does not include the bytes
for the END_GROUP tag information.
N( R ( R t
serialized( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt MergeFromString� s c C s | j � | j | � d S( s9 Like MergeFromString(), except we clear the object first.N( R R ( R R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt ParseFromString� s
c C s
t � d S( s! Serializes the protocol message to a binary string.
Returns:
A binary string representation of the message if all of the required
fields in the message are set (i.e. the message is initialized).
Raises:
message.EncodeError if the message isn't initialized.
N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt SerializeToString� s
c C s
t � d S( s� Serializes the protocol message to a binary string.
This method is similar to SerializeToString but doesn't check if the
message is initialized.
Returns:
A string representation of the partial message.
N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt SerializePartialToString� s c C s
t � d S( s# Returns a list of (FieldDescriptor, value) tuples for all
fields in the message which are not empty. A singular field is non-empty
if HasField() would return true, and a repeated field is non-empty if
it contains at least one element. The fields are ordered by field
numberN( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt
ListFields� s c C s
t � d S( s� Checks if a certain field is set for the message. Note if the
field_name is not defined in the message descriptor, ValueError will be
raised.N( R ( R t
field_name( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt HasField� s c C s
t � d S( N( R ( R R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt
ClearField� s c C s
t � d S( N( R ( R t extension_handle( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt HasExtension� s c C s
t � d S( N( R ( R R! ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt ClearExtension� s c C s
t � d S( sm Returns the serialized size of this message.
Recursively calls ByteSize() on all contained messages.
N( R ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt ByteSize� s c C s
t � d S( s6 Internal method used by the protocol message implementation.
Clients should not call this directly.
Sets a listener that this message will call on certain state transitions.
The purpose of this method is to register back-edges from children to
parents at runtime, for the purpose of setting "has" bits and
byte-size-dirty bits in the parent and ancestor objects whenever a child or
descendant object is modified.
If the client wants to disconnect this Message from the object tree, she
explicitly sets callback to None.
If message_listener is None, unregisters any existing listener. Otherwise,
message_listener must implement the MessageListener interface in
internal/message_listener.py, and we discard any listener registered
via a previous _SetListener() call.
N( R ( R t message_listener( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt _SetListener� s c C s t d | j � � S( s Support the pickle protocol.R ( t dictR ( R ( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __getstate__ s c C s | j � | j | d � d S( s Support the pickle protocol.R N( t __init__R ( R t state( ( s; /usr/lib/python2.7/site-packages/google/protobuf/message.pyt __setstate__ s
N( R R t __doc__t __slots__t Nonet
DESCRIPTORR R R R R R R R R R R R R R R R R R R"